/*
 * Copyright 2002-2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.hsc.lock.interceptor;

import com.hsc.lock.annotation.Cacheable;
import com.hsc.lock.interceptor.key.KeyGenerator;
import com.hsc.lock.interceptor.key.SimpleKeyGenerator;
import org.springframework.aop.Pointcut;
import org.springframework.aop.framework.AbstractSingletonProxyFactoryBean;
import org.springframework.aop.support.DefaultPointcutAdvisor;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.BeanFactoryAware;
import org.springframework.beans.factory.SmartInitializingSingleton;
import org.springframework.cache.CacheManager;

/**
 * Proxy factory bean for simplified declarative caching handling.
 * This is a convenient alternative to a standard AOP
 * {@link org.springframework.aop.framework.ProxyFactoryBean}
 * with a separate {@link LockInterceptor} definition.
 *
 * <p>This class is designed to facilitate declarative cache demarcation: namely, wrapping
 * a singleton target object with a caching proxy, proxying all the interfaces that the
 * target implements. Exists primarily for third-party framework integration.
 * <strong>Users should favor the {@code cache:} XML namespace
 * {@link Cacheable @Cacheable} annotation.</strong>
 * See the
 * <a href="https://docs.spring.io/spring/docs/current/spring-framework-reference/integration.html#cache-annotations">declarative annotation-based caching</a>
 * section of the Spring reference documentation for more information.
 *
 * @author Costin Leau
 * @author Juergen Hoeller
 * @see org.springframework.aop.framework.ProxyFactoryBean
 * @see LockInterceptor
 * @since 3.1
 */
@SuppressWarnings("serial")
public class LockProxyFactoryBean extends AbstractSingletonProxyFactoryBean
        implements BeanFactoryAware, SmartInitializingSingleton {

    private final LockInterceptor cacheInterceptor = new LockInterceptor();

    private Pointcut pointcut = Pointcut.TRUE;


    /**
     * Set one or more sources to find cache operations.
     *
     * @see LockInterceptor#setCacheOperationSources
     */
    public void setCacheOperationSources(OperationSource... cacheOperationSources) {
        this.cacheInterceptor.setCacheOperationSources(cacheOperationSources);
    }

    /**
     * Set the default {@link KeyGenerator} that this cache aspect should delegate to
     * if no specific key generator has been set for the operation.
     * <p>The default is a {@link SimpleKeyGenerator}.
     *
     * @see LockInterceptor#setKeyGenerator
     * @since 5.0.3
     */
    public void setKeyGenerator(KeyGenerator keyGenerator) {
        this.cacheInterceptor.setKeyGenerator(keyGenerator);
    }

    /**
     * Set the default {@link LockResolver} that this cache aspect should delegate
     * to if no specific cache resolver has been set for the operation.
     * <p>The default resolver resolves the caches against their names and the
     * default cache manager.
     *
     * @see LockInterceptor#setCacheResolver
     * @since 5.0.3
     */
    public void setCacheResolver(LockResolver cacheResolver) {
        this.cacheInterceptor.setCacheResolver(cacheResolver);
    }

    /**
     * Set the {@link CacheManager} to use to create a default {@link LockResolver}.
     * Replace the current {@link LockResolver}, if any.
     *
     * @see LockInterceptor#setCacheManager
     * @since 5.0.3
     */
    public void setCacheManager(CacheManager cacheManager) {
        this.cacheInterceptor.setCacheManager(cacheManager);
    }

    /**
     * Set a pointcut, i.e. a bean that triggers conditional invocation of the
     * {@link LockInterceptor} depending on the method and attributes passed.
     * <p>Note: Additional interceptors are always invoked.
     *
     * @see #setPreInterceptors
     * @see #setPostInterceptors
     */
    public void setPointcut(Pointcut pointcut) {
        this.pointcut = pointcut;
    }

    @Override
    public void setBeanFactory(BeanFactory beanFactory) {
        this.cacheInterceptor.setBeanFactory(beanFactory);
    }

    @Override
    public void afterSingletonsInstantiated() {
        this.cacheInterceptor.afterSingletonsInstantiated();
    }


    @Override
    protected Object createMainInterceptor() {
        this.cacheInterceptor.afterPropertiesSet();
        return new DefaultPointcutAdvisor(this.pointcut, this.cacheInterceptor);
    }

}
